/*
 * Copyright 2009 Jamie Gennis
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.code.gwt.remoteaction.client;

import com.google.gwt.user.client.rpc.IsSerializable;

/**
 * A wrapper around the result of an action.
 *
 * @author jgennis
 */
public interface ActionResult extends IsSerializable {

  /**
   * Get the result of the action.
   *
   * Note that this may be {@code null} even if the action succeeded, as it can
   * return {@code null}.  The return value of {@link #getException()} should
   * be checked to determine whether the action was a success.
   * 
   * @return the result if the action succeeded, {@code null} otherwise
   */
  public Object getResult();

  /**
   * Get the exception that was thrown by the action.
   * 
   * @return the {@code Throwable} that the action threw, or {@code null} if
   *         the action completed without throwing
   */
  public Throwable getException();
}
